Fix optional bodies #5271
Fix optional bodies #5271
Conversation
|
Following you can find the validation changes against the target branch for the API.
You can validate this API yourself by using the |
pquentin
left a comment
pquentin
left a comment
There was a problem hiding this comment.
For each change, I have linked the corresponding server code justifying the change and sometimes additional evidence.
| master_timeout?: Duration | ||
| } | ||
| body: { | ||
| body?: { |
| sort?: string | string[] | ||
| } | ||
| body: { | ||
| body?: { |
There was a problem hiding this comment.
| master_timeout?: Duration | ||
| } | ||
| body: { | ||
| body?: { |
| timeout?: Duration | ||
| } | ||
| body: { | ||
| body?: { |
| /** @codegen_name index_template */ | ||
| body?: IndexTemplate |
There was a problem hiding this comment.
| debug?: boolean | ||
| } | ||
| body: { | ||
| body?: { |
| } | ||
| ] | ||
| body: { | ||
| body?: { |
| id?: Id | ||
| } | ||
| body: { | ||
| body?: { |
| include_defaults?: boolean | ||
| } | ||
| body: { | ||
| body?: { |
| } | ||
| /** @codegen_name create_from */ | ||
| body: CreateFrom | ||
| body?: CreateFrom |
There was a problem hiding this comment.
pquentin
left a comment
pquentin
left a comment
There was a problem hiding this comment.
Added two APIs which I initially thought required a body. The server code was unclear, but the YAML tests provided clarity.
| wait_for_completion?: boolean | ||
| } | ||
| body: { | ||
| body?: { |
There was a problem hiding this comment.
YAML test that creates a snapshot without a body: https://github.com/elastic/elasticsearch/blob/a82b5cfb0ff7d22b95c56a8e7dcd7c5f3ba4ff24/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/snapshot.create/10_basic.yml#L23-L27
There was a problem hiding this comment.
| wait_for_completion?: boolean | ||
| } | ||
| body: { | ||
| body?: { |
There was a problem hiding this comment.
YAML test that restores a snapshot without a body: https://github.com/elastic/elasticsearch/blob/a82b5cfb0ff7d22b95c56a8e7dcd7c5f3ba4ff24/modules/repository-gcs/src/yamlRestTest/resources/rest-api-spec/test/repository_gcs/20_repository.yml#L139-L144
There was a problem hiding this comment.
* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f)
* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f)
* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f) Co-authored-by: Quentin Pradet <[email protected]>
* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f) Co-authored-by: Quentin Pradet <[email protected]>
Many bodies were correctly set as optional in the rest-api-spec, but incorrectly set as required in the Elasticsearch specification. There are three errors in rest-api-spec too. When I fix them, I can commit the compiler change that allowed me to see this.